Welcome to the MiCamp Solutions gateway JSON API.
You can use our API endpoints to easily and securely charge and credit transactions.
To use the MiCamp Solutions API, you must have a merchant account and source key from the MiCamp Solutions gateway.
To create a source key in the gateway, navigate to Control Panel > Source Management > Create Key.
Production API base URI:
https://api.micampblue.com/api/v2/
Sandbox API base URI:
https://api.sandbox.micampblue.com/api/v2/
Please use the User-Agent header to
identify your software, so requests coming from your
integration can be traced.
Creates a new authorization / charge. For credit cards, by default, the authorization will be captured into the current batch.
A charge can be from one of the following types of sources:
For check transactions, this request requires the
Check Charge permission on the source key. For CC
transactions, if capture is
false, it requires the Auth Only
permission, otherwise, it requires the Charge
permission.
|
amount
required
|
number
[ 0.01 .. 20000000 ]
Transaction amount in USD. If a mandatory surcharge is set by the ISO/MSP, the actual amount charged could be different than the amount submitted in this field. The revised amounts will be returned in the response.
The
|
|
card
required
|
string
[ 14 .. 16 ] characters
^\d+$
Card number |
|
expiry_month
required
|
integer
[ 1 .. 12 ]
Card expiration month. If using a card token, send any valid month. |
|
expiry_year
required
|
integer
[ 2020 .. 9999 ]
Card expiration year. If using a card token, send any valid year. |
|
object
(AmountDetails)
Breakdown of the amount. These fields do not affect the actual transaction amount and are for reporting and Level 3 only. |
|
| name |
string
<= 255 characters
Name on payment method (credit card or check). |
|
object
Additional optional transaction details. |
|
|
Array of objects
(Item)
non-empty
Line item details for Level 3 data. The data will not be checked for accuracy, e.g. if the totals add up correctly. To qualify for Level 3, the line item amounts must match the transaction amounts. The following fields are required for Level 3 data:
|
|
|
object
(Address)
|
|
|
object
For level 3, the country must be in ISO 3166-1 alpha-2 format (2 letter code) and the zip code format must match the country. |
|
|
object
(CustomFields)
|
|
| ignore_duplicates |
boolean
Default:
false
Determines whether to override any duplicate transactions detection. |
|
object
|
|
|
object
(TransactionFlags)
These flags provide more details about the transaction. Although they are optional, is recommended they be sent, to ensure optimal approval rates. |
|
| avs_address |
string
<= 255 characters
Billing address for the card. |
| avs_zip |
string
<= 50 characters
Billing zip code for the card. While not required, this field should be populated for fraud prevention and to obtain the best rate for E-commerce credit card transactions. |
| cvv2 |
string
[ 3 .. 4 ] characters
^\d+$
Security code, otherwise known as CVC or CID. For Amex, this is the 4 digit code on the front of the card. For other card brands, this is the 3 digit code on the back. While not required, this field should be populated for fraud prevention. |
|
object
Data for 3D-Secure (Verified by Visa, MasterCard SecureCode, Amex SafeKey, Discover ProtectBuy). These values come from a 3rd party 3D-Secure provider. Note: 3D-Secure is only applicable for e-Commerce merchants. Only 3D-Secure version 2 is supported. |
|
| capture |
boolean
Default:
true
Whether to capture the authorization into the current batch. |
| save_card |
boolean
Default:
false
If set to true and the transaction has been approved, the system will issue a token for future use. |
{
-
"amount":
0.01,
-
"amount_details":
{
-
"tax":
20000000,
-
"surcharge":
20000000,
-
"shipping":
20000000,
-
"tip":
20000000,
-
"discount":
20000000
},
-
"name":
"string",
-
"transaction_details":
{
-
"description":
"string",
-
"clerk":
"string",
-
"terminal":
"string",
-
"client_ip":
"string",
-
"signature":
"string",
-
"invoice_number":
"string",
-
"po_number":
"string",
-
"order_number":
"string"
},
-
"line_items":
[
-
{
-
"sku":
"string",
-
"name":
"string",
-
"description":
"string",
-
"cost":
0.0001,
-
"quantity":
1,
-
"tax_rate":
30,
-
"tax_amount":
0,
-
"unit_of_measure":
"str",
-
"commodity_code":
"stringst",
-
"discount_rate":
100,
-
"discount_amount":
0
}
],
-
"billing_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"shipping_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"custom_fields":
{
-
"custom1":
"string",
-
"custom2":
"string",
-
"custom3":
"string",
-
"custom4":
"string",
-
"custom5":
"string",
-
"custom6":
"string",
-
"custom7":
"string",
-
"custom8":
"string",
-
"custom9":
"string",
-
"custom10":
"string",
-
"custom11":
"string",
-
"custom12":
"string",
-
"custom13":
"string",
-
"custom14":
"string",
-
"custom15":
"string",
-
"custom16":
"string",
-
"custom17":
"string",
-
"custom18":
"string",
-
"custom19":
"string",
-
"custom20":
"string"
},
-
"ignore_duplicates":
false,
-
"customer":
{
-
"send_receipt":
false,
-
"email":
"string",
-
"fax":
"string",
-
"identifier":
"string",
-
"customer_id":
1
},
-
"transaction_flags":
{
-
"allow_partial_approval":
false,
-
"is_recurring":
false,
-
"is_installment":
false,
-
"is_customer_initiated":
false,
-
"cardholder_present":
false,
-
"card_present":
false,
-
"terminal":
{
-
"operating_environment":
0,
-
"cardholder_authentication_method":
"0",
-
"cardholder_authentication_entity":
0,
-
"print_capability":
false
}
},
-
"avs_address":
"string",
-
"avs_zip":
"string",
-
"expiry_month":
1,
-
"expiry_year":
2020,
-
"cvv2":
"stri",
-
"3d_secure":
{
-
"eci":
"00",
-
"cavv":
"stringstringstringstringstri",
-
"ds_trans_id":
"084f49cd-2a97-4b13-87a7-a1bd8267cb20"
},
-
"card":
"stringstringst",
-
"capture":
true,
-
"save_card":
false
}
{
-
"version":
"string",
-
"status":
"Approved",
-
"status_code":
"A",
-
"error_message":
"string",
-
"error_code":
"string",
-
"error_details":
"string",
-
"auth_amount":
0,
-
"auth_code":
"string",
-
"reference_number":
1,
-
"transaction":
{
-
"id":
1,
-
"created_at":
"2019-08-24T14:15:22Z",
-
"settled_date":
"2019-08-24",
-
"amount_details":
{
-
"amount":
0.01,
-
"tax":
0,
-
"surcharge":
0,
-
"shipping":
0,
-
"tip":
0,
-
"discount":
0,
-
"subtotal":
0,
-
"original_requested_amount":
0.01,
-
"original_authorized_amount":
0.01
},
-
"transaction_details":
{
-
"description":
"string",
-
"clerk":
"string",
-
"terminal":
"string",
-
"client_ip":
"string",
-
"signature":
"string",
-
"invoice_number":
"string",
-
"po_number":
"string",
-
"order_number":
"string",
-
"batch_id":
1,
-
"source":
"string",
-
"terminal_name":
"string",
-
"terminal_id":
"string",
-
"username":
"string",
-
"type":
"charge",
-
"reference_number":
1,
-
"schedule_id":
0
},
-
"customer":
{
-
"identifier":
"string",
-
"email":
"string",
-
"fax":
"string",
-
"customer_id":
1
},
-
"status_details":
{
-
"error_code":
"string",
-
"error_message":
"string",
-
"status":
"captured"
},
-
"billing_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"shipping_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"custom_fields":
{
-
"custom1":
"string",
-
"custom2":
"string",
-
"custom3":
"string",
-
"custom4":
"string",
-
"custom5":
"string",
-
"custom6":
"string",
-
"custom7":
"string",
-
"custom8":
"string",
-
"custom9":
"string",
-
"custom10":
"string",
-
"custom11":
"string",
-
"custom12":
"string",
-
"custom13":
"string",
-
"custom14":
"string",
-
"custom15":
"string",
-
"custom16":
"string",
-
"custom17":
"string",
-
"custom18":
"string",
-
"custom19":
"string",
-
"custom20":
"string"
},
-
"check_details":
{
-
"name":
"string",
-
"routing_number":
"string",
-
"account_number_last4":
"string",
-
"account_type":
"checking",
-
"sec_code":
"PPD",
-
"returned_at":
"2019-08-24",
-
"returned_code":
"string",
-
"returned_reason":
"string"
},
-
"card_details":
{
-
"name":
"string",
-
"last4":
"stri",
-
"expiry_month":
1,
-
"expiry_year":
2020,
-
"card_type":
"Visa",
-
"avs_street":
"string",
-
"avs_zip":
"string",
-
"auth_code":
"string",
-
"bin":
"string",
-
"bin_details":
{
-
"type":
"C"
},
-
"avs_result":
"string",
-
"avs_result_code":
"YYY",
-
"cvv_result":
"string",
-
"cvv_result_code":
"M",
-
"cavv_result":
"string",
-
"cavv_result_code":
"string"
}
},
-
"avs_result":
"string",
-
"avs_result_code":
"YYY",
-
"cvv2_result":
"string",
-
"cvv2_result_code":
"M",
-
"card_type":
"Visa",
-
"last_4":
"string",
-
"card_ref":
"string"
}
|
amount
required
|
number
[ 0.01 .. 20000000 ]
Transaction amount in USD. If a mandatory surcharge is set by the ISO/MSP, the actual amount charged could be different than the amount submitted in this field. The revised amounts will be returned in the response.
The
|
|
terminal_id
required
|
string
non-empty
The serial number of the terminal. This must match a terminal that is boarded in the gateway. |
|
object
(AmountDetails)
Breakdown of the amount. These fields do not affect the actual transaction amount and are for reporting and Level 3 only. |
|
| name |
string
<= 255 characters
Name on payment method (credit card or check). |
|
object
Additional optional transaction details. |
|
|
Array of objects
(Item)
non-empty
Line item details for Level 3 data. The data will not be checked for accuracy, e.g. if the totals add up correctly. To qualify for Level 3, the line item amounts must match the transaction amounts. The following fields are required for Level 3 data:
|
|
|
object
(Address)
|
|
|
object
For level 3, the country must be in ISO 3166-1 alpha-2 format (2 letter code) and the zip code format must match the country. |
|
|
object
(CustomFields)
|
|
| ignore_duplicates |
boolean
Default:
false
Determines whether to override any duplicate transactions detection. |
|
object
|
|
| source |
string
<= 26 characters
(tkn|ref|pm)-[A-Za-z0-9]+
The source to charge. This can be a token, a payment method or the reference number of a previous transaction. If this field is not sent, the terminal will prompt for a card. The appropriate prefix must be used:
By default, a source charge sent without an expiration date will use the expiration date saved with the source. If an expiration date is sent, it will override the saved expiration date. AVS fields will be automatically populated when using a payment method source unless overridden in the request. |
| save_card |
boolean
Default:
false
If set to true and the transaction has been approved, the system will issue a token for future use. |
{
-
"amount":
0.01,
-
"amount_details":
{
-
"tax":
20000000,
-
"surcharge":
20000000,
-
"shipping":
20000000,
-
"tip":
20000000,
-
"discount":
20000000
},
-
"name":
"string",
-
"transaction_details":
{
-
"description":
"string",
-
"clerk":
"string",
-
"terminal":
"string",
-
"client_ip":
"string",
-
"signature":
"string",
-
"invoice_number":
"string",
-
"po_number":
"string",
-
"order_number":
"string"
},
-
"line_items":
[
-
{
-
"sku":
"string",
-
"name":
"string",
-
"description":
"string",
-
"cost":
0.0001,
-
"quantity":
1,
-
"tax_rate":
30,
-
"tax_amount":
0,
-
"unit_of_measure":
"str",
-
"commodity_code":
"stringst",
-
"discount_rate":
100,
-
"discount_amount":
0
}
],
-
"billing_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"shipping_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"custom_fields":
{
-
"custom1":
"string",
-
"custom2":
"string",
-
"custom3":
"string",
-
"custom4":
"string",
-
"custom5":
"string",
-
"custom6":
"string",
-
"custom7":
"string",
-
"custom8":
"string",
-
"custom9":
"string",
-
"custom10":
"string",
-
"custom11":
"string",
-
"custom12":
"string",
-
"custom13":
"string",
-
"custom14":
"string",
-
"custom15":
"string",
-
"custom16":
"string",
-
"custom17":
"string",
-
"custom18":
"string",
-
"custom19":
"string",
-
"custom20":
"string"
},
-
"ignore_duplicates":
false,
-
"customer":
{
-
"send_receipt":
false,
-
"email":
"string",
-
"fax":
"string",
-
"identifier":
"string",
-
"customer_id":
1
},
-
"terminal_id":
"string",
-
"source":
"string",
-
"save_card":
false
}
{
-
"version":
"string",
-
"status":
"Approved",
-
"status_code":
"A",
-
"error_message":
"string",
-
"error_code":
"string",
-
"error_details":
"string",
-
"auth_amount":
0,
-
"auth_code":
"string",
-
"reference_number":
1,
-
"transaction":
{
-
"id":
1,
-
"created_at":
"2019-08-24T14:15:22Z",
-
"settled_date":
"2019-08-24",
-
"amount_details":
{
-
"amount":
0.01,
-
"tax":
0,
-
"surcharge":
0,
-
"shipping":
0,
-
"tip":
0,
-
"discount":
0,
-
"subtotal":
0,
-
"original_requested_amount":
0.01,
-
"original_authorized_amount":
0.01
},
-
"transaction_details":
{
-
"description":
"string",
-
"clerk":
"string",
-
"terminal":
"string",
-
"client_ip":
"string",
-
"signature":
"string",
-
"invoice_number":
"string",
-
"po_number":
"string",
-
"order_number":
"string",
-
"batch_id":
1,
-
"source":
"string",
-
"terminal_name":
"string",
-
"terminal_id":
"string",
-
"username":
"string",
-
"type":
"charge",
-
"reference_number":
1,
-
"schedule_id":
0
},
-
"customer":
{
-
"identifier":
"string",
-
"email":
"string",
-
"fax":
"string",
-
"customer_id":
1
},
-
"status_details":
{
-
"error_code":
"string",
-
"error_message":
"string",
-
"status":
"captured"
},
-
"billing_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"shipping_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"custom_fields":
{
-
"custom1":
"string",
-
"custom2":
"string",
-
"custom3":
"string",
-
"custom4":
"string",
-
"custom5":
"string",
-
"custom6":
"string",
-
"custom7":
"string",
-
"custom8":
"string",
-
"custom9":
"string",
-
"custom10":
"string",
-
"custom11":
"string",
-
"custom12":
"string",
-
"custom13":
"string",
-
"custom14":
"string",
-
"custom15":
"string",
-
"custom16":
"string",
-
"custom17":
"string",
-
"custom18":
"string",
-
"custom19":
"string",
-
"custom20":
"string"
},
-
"check_details":
{
-
"name":
"string",
-
"routing_number":
"string",
-
"account_number_last4":
"string",
-
"account_type":
"checking",
-
"sec_code":
"PPD",
-
"returned_at":
"2019-08-24",
-
"returned_code":
"string",
-
"returned_reason":
"string"
},
-
"card_details":
{
-
"name":
"string",
-
"last4":
"stri",
-
"expiry_month":
1,
-
"expiry_year":
2020,
-
"card_type":
"Visa",
-
"avs_street":
"string",
-
"avs_zip":
"string",
-
"auth_code":
"string",
-
"bin":
"string",
-
"bin_details":
{
-
"type":
"C"
},
-
"avs_result":
"string",
-
"avs_result_code":
"YYY",
-
"cvv_result":
"string",
-
"cvv_result_code":
"M",
-
"cavv_result":
"string",
-
"cavv_result_code":
"string"
}
},
-
"avs_result":
"string",
-
"avs_result_code":
"YYY",
-
"cvv2_result":
"string",
-
"cvv2_result_code":
"M",
-
"card_type":
"Visa",
-
"last_4":
"string",
-
"card_ref":
"string"
}
Capture an authorization into the current batch. If the authorization is already captured, this will still return a successful response.
Only applicable to credit card authorizations.
Not supported for terminal transactions.
This request requires the Capture permission on the source key.
|
reference_number
required
|
integer
>= 1
Reference number of the authorization to capture. |
{
-
"reference_number":
1
}
{
-
"version":
"string",
-
"status":
"Approved",
-
"status_code":
"A",
-
"error_message":
"string",
-
"error_code":
"string",
-
"error_details":
"string",
-
"auth_amount":
0,
-
"auth_code":
"string"
}
Adjust the amount or details of a previous unsettled transaction.
This endpoint requires that the source key have a pin.
The amount of ACH and Terminal transactions cannot be adjusted, and will return an error if a different amount is sent.
If the original transaction had amount details and
this request changes the amount, the
amount_details must be resent. If only
details are being adjusted and not the amount, the
amount field can be omitted.
This request requires the Adjust permission on the source key.
TSYS only supports adjusts on transactions using US or Canadian cards. International cards must use refunds after the transaction has settled.
Adjusting a transaction to a higher amount is only permitted by the card brands in specific scenarios. It is the the responsibility of the merchant to enforce this.
A transaction can only be adjusted once.
|
reference_number
required
|
integer
>= 1
Reference number of the transaction to adjust. |
| amount |
number
[ 0.01 .. 20000000 ]
Amount to adjust the original transaction to. |
|
object
(BaseTransactionCustomer)
|
|
|
object
Additional optional transaction details. |
|
|
object
(AmountDetails)
Breakdown of the amount. These fields do not affect the actual transaction amount and are for reporting and Level 3 only. |
|
|
object
(Address)
|
|
|
object
(Address)
|
|
|
object
(CustomFields)
|
|
|
Array of objects
(Item)
non-empty
Line item details for Level 3 data. The data will not be checked for accuracy, e.g. if the totals add up correctly. To qualify for Level 3, the line item amounts must match the transaction amounts. The new data will replace the old data. |
{
-
"reference_number":
1,
-
"amount":
0.01,
-
"customer":
{
-
"send_receipt":
false,
-
"email":
"string",
-
"fax":
"string",
-
"identifier":
"string"
},
-
"transaction_details":
{
-
"description":
"string",
-
"clerk":
"string",
-
"terminal":
"string",
-
"client_ip":
"string",
-
"signature":
"string",
-
"invoice_number":
"string",
-
"po_number":
"string",
-
"order_number":
"string"
},
-
"amount_details":
{
-
"tax":
20000000,
-
"surcharge":
20000000,
-
"shipping":
20000000,
-
"tip":
20000000,
-
"discount":
20000000
},
-
"billing_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"shipping_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"custom_fields":
{
-
"custom1":
"string",
-
"custom2":
"string",
-
"custom3":
"string",
-
"custom4":
"string",
-
"custom5":
"string",
-
"custom6":
"string",
-
"custom7":
"string",
-
"custom8":
"string",
-
"custom9":
"string",
-
"custom10":
"string",
-
"custom11":
"string",
-
"custom12":
"string",
-
"custom13":
"string",
-
"custom14":
"string",
-
"custom15":
"string",
-
"custom16":
"string",
-
"custom17":
"string",
-
"custom18":
"string",
-
"custom19":
"string",
-
"custom20":
"string"
},
-
"line_items":
[
-
{
-
"sku":
"string",
-
"name":
"string",
-
"description":
"string",
-
"cost":
0.0001,
-
"quantity":
1,
-
"tax_rate":
30,
-
"tax_amount":
0,
-
"unit_of_measure":
"str",
-
"commodity_code":
"stringst",
-
"discount_rate":
100,
-
"discount_amount":
0
}
]
}
{
-
"version":
"string",
-
"status":
"Approved",
-
"status_code":
"A",
-
"error_message":
"string",
-
"error_code":
"string",
-
"error_details":
"string",
-
"auth_amount":
0,
-
"auth_code":
"string"
}
Adjust the amount or details of a previous unsettled transaction, and captures it into the batch.
This endpoint requires that the source key have a pin.
This endpoint only applies to credit card transactions, and will return an error for ACH transactions.
If the original transaction had amount details and
this request changes the amount, the
amount_details must be resent. If only
details are being adjusted and not the amount, the
amount field can be omitted.
This request requires the Capture permission on the source key. If the amount is adjusted, the request will require Adjust permission as well.
TSYS only supports adjusts on transactions using US or Canadian cards. International cards must use refunds.
Adjusting a transaction should only be done in a compliant manner and is the responsibility of the merchant.
A transaction can only be adjusted once.
|
reference_number
required
|
integer
>= 1
Reference number of the transaction to adjust. |
| amount |
number
[ 0.01 .. 20000000 ]
Amount to adjust the original transaction to. |
|
object
(BaseTransactionCustomer)
|
|
|
object
Additional optional transaction details. |
|
|
object
(AmountDetails)
Breakdown of the amount. These fields do not affect the actual transaction amount and are for reporting and Level 3 only. |
|
|
object
(Address)
|
|
|
object
(Address)
|
|
|
object
(CustomFields)
|
|
|
Array of objects
(Item)
non-empty
Line item details for Level 3 data. The data will not be checked for accuracy, e.g. if the totals add up correctly. To qualify for Level 3, the line item amounts must match the transaction amounts. The new data will replace the old data. |
{
-
"reference_number":
1,
-
"amount":
0.01,
-
"customer":
{
-
"send_receipt":
false,
-
"email":
"string",
-
"fax":
"string",
-
"identifier":
"string"
},
-
"transaction_details":
{
-
"description":
"string",
-
"clerk":
"string",
-
"terminal":
"string",
-
"client_ip":
"string",
-
"signature":
"string",
-
"invoice_number":
"string",
-
"po_number":
"string",
-
"order_number":
"string"
},
-
"amount_details":
{
-
"tax":
20000000,
-
"surcharge":
20000000,
-
"shipping":
20000000,
-
"tip":
20000000,
-
"discount":
20000000
},
-
"billing_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"shipping_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"custom_fields":
{
-
"custom1":
"string",
-
"custom2":
"string",
-
"custom3":
"string",
-
"custom4":
"string",
-
"custom5":
"string",
-
"custom6":
"string",
-
"custom7":
"string",
-
"custom8":
"string",
-
"custom9":
"string",
-
"custom10":
"string",
-
"custom11":
"string",
-
"custom12":
"string",
-
"custom13":
"string",
-
"custom14":
"string",
-
"custom15":
"string",
-
"custom16":
"string",
-
"custom17":
"string",
-
"custom18":
"string",
-
"custom19":
"string",
-
"custom20":
"string"
},
-
"line_items":
[
-
{
-
"sku":
"string",
-
"name":
"string",
-
"description":
"string",
-
"cost":
0.0001,
-
"quantity":
1,
-
"tax_rate":
30,
-
"tax_amount":
0,
-
"unit_of_measure":
"str",
-
"commodity_code":
"stringst",
-
"discount_rate":
100,
-
"discount_amount":
0
}
]
}
{
-
"version":
"string",
-
"status":
"Approved",
-
"status_code":
"A",
-
"error_message":
"string",
-
"error_code":
"string",
-
"error_details":
"string",
-
"auth_amount":
0,
-
"auth_code":
"string"
}
Removes the authorization from the current open batch and places it into the queue. If the authorization is already queued, this will still return a successful response.
Only applicable to credit card authorizations. This is not supported for terminal transactions.
This request requires the Capture permission on the source key.
|
reference_number
required
|
integer
>= 1
Reference number of the authorization to queue. |
{
-
"reference_number":
1
}
Verifies that a card number, and optionally AVS and/or CVV2 data, is valid.
Only applicable to credit card authorizations. This transaction will not be saved in the gateway.
This request requires the Auth Only permission on the source key.
For Amex cards, if a CVV2 is sent and an Amex processor is available, it will be used, regardless of processor logic. If the only CC processor is a Fiserv (FirstData) platform, the CVV2 might be left out of the verification request sent to the processor, since their platforms do not support CVV2 in all situations.
|
card
required
|
string
[ 14 .. 16 ] characters
^\d+$
Card number |
|
expiry_month
required
|
integer
[ 1 .. 12 ]
Card expiration month. If using a card token, send any valid month. |
|
expiry_year
required
|
integer
[ 2020 .. 9999 ]
Card expiration year. If using a card token, send any valid year. |
| avs_address |
string
<= 255 characters
Billing address for the card. |
| avs_zip |
string
<= 50 characters
Billing zip code for the card. While not required, this field should be populated for fraud prevention and to obtain the best rate for E-commerce credit card transactions. |
| name |
string
<= 255 characters
Name on card |
|
object
(BaseTransactionDetails)
Additional optional transaction details. |
|
| save_card |
boolean
Default:
false
If set to true and the transaction has been approved, the system will issue a token for future use. |
|
object
(TransactionFlags)
These flags provide more details about the transaction. Although they are optional, is recommended they be sent, to ensure optimal approval rates. |
|
| cvv2 |
string
[ 3 .. 4 ] characters
^\d+$
Security code, otherwise known as CVC or CID. For Amex, this is the 4 digit code on the front of the card. For other card brands, this is the 3 digit code on the back. While not required, this field should be populated for fraud prevention. |
|
object
Data for 3D-Secure (Verified by Visa, MasterCard SecureCode, Amex SafeKey, Discover ProtectBuy). These values come from a 3rd party 3D-Secure provider. Note: 3D-Secure is only applicable for e-Commerce merchants. Only 3D-Secure version 2 is supported. |
{
-
"avs_address":
"string",
-
"avs_zip":
"string",
-
"name":
"string",
-
"transaction_details":
{
-
"description":
"string",
-
"clerk":
"string",
-
"terminal":
"string",
-
"client_ip":
"string",
-
"signature":
"string"
},
-
"save_card":
false,
-
"transaction_flags":
{
-
"allow_partial_approval":
false,
-
"is_recurring":
false,
-
"is_installment":
false,
-
"is_customer_initiated":
false,
-
"cardholder_present":
false,
-
"card_present":
false,
-
"terminal":
{
-
"operating_environment":
0,
-
"cardholder_authentication_method":
"0",
-
"cardholder_authentication_entity":
0,
-
"print_capability":
false
}
},
-
"expiry_month":
1,
-
"expiry_year":
2020,
-
"cvv2":
"stri",
-
"3d_secure":
{
-
"eci":
"00",
-
"cavv":
"stringstringstringstringstri",
-
"ds_trans_id":
"084f49cd-2a97-4b13-87a7-a1bd8267cb20"
},
-
"card":
"stringstringst"
}
{
-
"version":
"string",
-
"status":
"Approved",
-
"status_code":
"A",
-
"error_message":
"string",
-
"error_code":
"string",
-
"error_details":
"string",
-
"avs_result":
"string",
-
"avs_result_code":
"YYY",
-
"cvv2_result":
"string",
-
"cvv2_result_code":
"M",
-
"card_type":
"string",
-
"last_4":
"string",
-
"card_ref":
"string",
-
"transaction":
{
-
"id":
1,
-
"created_at":
"2019-08-24T14:15:22Z",
-
"settled_date":
"2019-08-24",
-
"amount_details":
{
-
"amount":
0.01,
-
"tax":
0,
-
"surcharge":
0,
-
"shipping":
0,
-
"tip":
0,
-
"discount":
0,
-
"subtotal":
0,
-
"original_requested_amount":
0.01,
-
"original_authorized_amount":
0.01
},
-
"transaction_details":
{
-
"description":
"string",
-
"clerk":
"string",
-
"terminal":
"string",
-
"client_ip":
"string",
-
"signature":
"string",
-
"invoice_number":
"string",
-
"po_number":
"string",
-
"order_number":
"string",
-
"batch_id":
1,
-
"source":
"string",
-
"terminal_name":
"string",
-
"terminal_id":
"string",
-
"username":
"string",
-
"type":
"charge",
-
"reference_number":
1,
-
"schedule_id":
0
},
-
"customer":
{
-
"identifier":
"string",
-
"email":
"string",
-
"fax":
"string",
-
"customer_id":
1
},
-
"status_details":
{
-
"error_code":
"string",
-
"error_message":
"string",
-
"status":
"captured"
},
-
"billing_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"shipping_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"custom_fields":
{
-
"custom1":
"string",
-
"custom2":
"string",
-
"custom3":
"string",
-
"custom4":
"string",
-
"custom5":
"string",
-
"custom6":
"string",
-
"custom7":
"string",
-
"custom8":
"string",
-
"custom9":
"string",
-
"custom10":
"string",
-
"custom11":
"string",
-
"custom12":
"string",
-
"custom13":
"string",
-
"custom14":
"string",
-
"custom15":
"string",
-
"custom16":
"string",
-
"custom17":
"string",
-
"custom18":
"string",
-
"custom19":
"string",
-
"custom20":
"string"
},
-
"card_details":
{
-
"name":
"string",
-
"last4":
"stri",
-
"expiry_month":
1,
-
"expiry_year":
2020,
-
"card_type":
"Visa",
-
"avs_street":
"string",
-
"avs_zip":
"string",
-
"auth_code":
"string",
-
"bin":
"string",
-
"bin_details":
{
-
"type":
"C"
},
-
"avs_result":
"string",
-
"avs_result_code":
"YYY",
-
"cvv_result":
"string",
-
"cvv_result_code":
"M",
-
"cavv_result":
"string",
-
"cavv_result_code":
"string"
}
}
}
Refund a previously settled charge. An error will be returned if the original transaction has not yet settled.
This request requires the Refund permission on the source key for CC transactions, and Check Refund for checks.
ACH transactions can only be refunded after 5 business days have passed since the transaction was processed.
Terminals with connected refunds will behave as matched refunds.
|
reference_number
required
|
integer
>= 1
Reference number of the transaction to refund. |
| terminal_id |
string
The serial number of the terminal. This must match a terminal that is boarded in the gateway. By default the refund transaction will process on the terminal that the original transaction was processed on. To specify a different terminal, this field can be set. |
| amount |
number
[ 0.01 .. 20000000 ]
Amount of original transaction to refund. Omit this field to refund the full amount. |
| cvv2 |
string
[ 3 .. 4 ] characters
^\d+$
Security code, otherwise known as CVC or CID. For Amex, this is the 4 digit code on the front of the card. For other card brands, this is the 3 digit code on the back. While not required, this field should be populated for fraud prevention. |
|
object
(BaseTransactionCustomer)
|
|
|
object
(BaseTransactionDetails)
Additional optional transaction details. |
|
|
object
(TransactionFlags)
These flags provide more details about the transaction. Although they are optional, is recommended they be sent, to ensure optimal approval rates. |
|
|
object
(CustomFields)
|
{
-
"reference_number":
1,
-
"terminal_id":
"string",
-
"amount":
0.01,
-
"cvv2":
"stri",
-
"customer":
{
-
"send_receipt":
false,
-
"email":
"string",
-
"fax":
"string",
-
"identifier":
"string"
},
-
"transaction_details":
{
-
"description":
"string",
-
"clerk":
"string",
-
"terminal":
"string",
-
"client_ip":
"string",
-
"signature":
"string"
},
-
"transaction_flags":
{
-
"allow_partial_approval":
false,
-
"is_recurring":
false,
-
"is_installment":
false,
-
"is_customer_initiated":
false,
-
"cardholder_present":
false,
-
"card_present":
false,
-
"terminal":
{
-
"operating_environment":
0,
-
"cardholder_authentication_method":
"0",
-
"cardholder_authentication_entity":
0,
-
"print_capability":
false
}
},
-
"custom_fields":
{
-
"custom1":
"string",
-
"custom2":
"string",
-
"custom3":
"string",
-
"custom4":
"string",
-
"custom5":
"string",
-
"custom6":
"string",
-
"custom7":
"string",
-
"custom8":
"string",
-
"custom9":
"string",
-
"custom10":
"string",
-
"custom11":
"string",
-
"custom12":
"string",
-
"custom13":
"string",
-
"custom14":
"string",
-
"custom15":
"string",
-
"custom16":
"string",
-
"custom17":
"string",
-
"custom18":
"string",
-
"custom19":
"string",
-
"custom20":
"string"
}
}
{
-
"version":
"string",
-
"status":
"Approved",
-
"status_code":
"A",
-
"error_message":
"string",
-
"error_code":
"string",
-
"error_details":
"string",
-
"reference_number":
1
}
Credit money back to a payment method.
A credit can be to one of 3 different types of sources:
This feature must be enabled by the ISO/MSP. It requires the Refund permission on the source key for CC transactions, and Check Refund for checks.
|
card
required
|
string
[ 14 .. 16 ] characters
^\d+$
Card number |
|
expiry_month
required
|
integer
[ 1 .. 12 ]
Card expiration month. If using a card token, send any valid month. |
|
expiry_year
required
|
integer
[ 2020 .. 9999 ]
Card expiration year. If using a card token, send any valid year. |
|
amount
required
|
number
[ 0.01 .. 20000000 ]
Amount to credit. |
| avs_address |
string
<= 255 characters
Billing address for the card. |
| avs_zip |
string
<= 50 characters
Billing zip code for the card. While not required, this field should be populated for fraud prevention and to obtain the best rate for E-commerce credit card transactions. |
| cvv2 |
string
[ 3 .. 4 ] characters
^\d+$
Security code, otherwise known as CVC or CID. For Amex, this is the 4 digit code on the front of the card. For other card brands, this is the 3 digit code on the back. While not required, this field should be populated for fraud prevention. |
| name |
string
<= 255 characters
Name on card |
|
object
|
|
|
object
Additional optional transaction details. |
|
|
object
(TransactionFlags)
These flags provide more details about the transaction. Although they are optional, is recommended they be sent, to ensure optimal approval rates. |
|
|
object
(CustomFields)
|
{
-
"avs_address":
"string",
-
"avs_zip":
"string",
-
"expiry_month":
1,
-
"expiry_year":
2020,
-
"cvv2":
"stri",
-
"name":
"string",
-
"card":
"stringstringst",
-
"amount":
0.01,
-
"customer":
{
-
"send_receipt":
false,
-
"email":
"string",
-
"fax":
"string",
-
"identifier":
"string",
-
"customer_id":
1
},
-
"transaction_details":
{
-
"description":
"string",
-
"clerk":
"string",
-
"terminal":
"string",
-
"client_ip":
"string",
-
"signature":
"string",
-
"invoice_number":
"string",
-
"po_number":
"string",
-
"order_number":
"string"
},
-
"transaction_flags":
{
-
"allow_partial_approval":
false,
-
"is_recurring":
false,
-
"is_installment":
false,
-
"is_customer_initiated":
false,
-
"cardholder_present":
false,
-
"card_present":
false,
-
"terminal":
{
-
"operating_environment":
0,
-
"cardholder_authentication_method":
"0",
-
"cardholder_authentication_entity":
0,
-
"print_capability":
false
}
},
-
"custom_fields":
{
-
"custom1":
"string",
-
"custom2":
"string",
-
"custom3":
"string",
-
"custom4":
"string",
-
"custom5":
"string",
-
"custom6":
"string",
-
"custom7":
"string",
-
"custom8":
"string",
-
"custom9":
"string",
-
"custom10":
"string",
-
"custom11":
"string",
-
"custom12":
"string",
-
"custom13":
"string",
-
"custom14":
"string",
-
"custom15":
"string",
-
"custom16":
"string",
-
"custom17":
"string",
-
"custom18":
"string",
-
"custom19":
"string",
-
"custom20":
"string"
}
}
{
-
"version":
"string",
-
"status":
"Approved",
-
"status_code":
"A",
-
"error_message":
"string",
-
"error_code":
"string",
-
"error_details":
"string",
-
"reference_number":
1
}
Credit money back to a payment method.
This feature must be enabled by the ISO/MSP. It requires the Refund permission on the source key for CC transactions, and Check Refund for checks.
|
terminal_id
required
|
string
The serial number of the terminal. This must match a terminal that is boarded in the gateway. |
|
amount
required
|
number
[ 0.01 .. 20000000 ]
Amount to credit. |
| source |
string
<= 26 characters
(tkn|ref|pm)-[A-Za-z0-9]+
The source to credit. This can be a token, a payment method, or the reference number of a previous transaction. If a reference number is sent, it will only be used to retrieve the account number, but the original transaction will not be affected. If this field is not sent, the terminal will prompt for a card. The appropriate prefix must be used:
By default, a source credit sent without an expiration date will use the expiration date saved with the source. If an expiration date is sent, it will override the saved expiration date. AVS fields will be automatically populated when using a payment method source unless overridden in the request. By default, a source credit sent without an expiration date will use the expiration date saved with the source. If an expiration date is sent, it will override the saved expiration date. Any extra payment method fields sent with a source (e.g. CVV or routing number) will be ignored. |
|
object
|
|
|
object
Additional optional transaction details. |
|
|
object
(CustomFields)
|
{
-
"terminal_id":
"string",
-
"amount":
0.01,
-
"source":
"string",
-
"customer":
{
-
"send_receipt":
false,
-
"email":
"string",
-
"fax":
"string",
-
"identifier":
"string",
-
"customer_id":
1
},
-
"transaction_details":
{
-
"description":
"string",
-
"clerk":
"string",
-
"terminal":
"string",
-
"client_ip":
"string",
-
"signature":
"string",
-
"invoice_number":
"string",
-
"po_number":
"string",
-
"order_number":
"string"
},
-
"custom_fields":
{
-
"custom1":
"string",
-
"custom2":
"string",
-
"custom3":
"string",
-
"custom4":
"string",
-
"custom5":
"string",
-
"custom6":
"string",
-
"custom7":
"string",
-
"custom8":
"string",
-
"custom9":
"string",
-
"custom10":
"string",
-
"custom11":
"string",
-
"custom12":
"string",
-
"custom13":
"string",
-
"custom14":
"string",
-
"custom15":
"string",
-
"custom16":
"string",
-
"custom17":
"string",
-
"custom18":
"string",
-
"custom19":
"string",
-
"custom20":
"string"
}
}
{
-
"version":
"string",
-
"status":
"Approved",
-
"status_code":
"A",
-
"error_message":
"string",
-
"error_code":
"string",
-
"error_details":
"string",
-
"reference_number":
1
}
Void a previously unsettled charge. An error will be returned if the original transaction has already been settled.
This request requires the Void permission on the source key for CC transactions, and Check Void for checks.
ACH transactions can only be voided until 1am Eastern Time.
FirstData terminal transactions are host capture and can only be voided within 25 minutes of the transaction.
TSYS only supports voids on transactions using US or Canadian cards. International cards must use refunds.
|
reference_number
required
|
integer
>= 1
Reference number of the transaction to void. |
|
object
(BaseTransactionCustomer)
|
|
|
object
(BaseTransactionDetails)
Additional optional transaction details. |
{
-
"reference_number":
1,
-
"customer":
{
-
"send_receipt":
false,
-
"email":
"string",
-
"fax":
"string",
-
"identifier":
"string"
},
-
"transaction_details":
{
-
"description":
"string",
-
"clerk":
"string",
-
"terminal":
"string",
-
"client_ip":
"string",
-
"signature":
"string"
}
}
{
-
"version":
"string",
-
"status":
"Approved",
-
"status_code":
"A",
-
"error_message":
"string",
-
"error_code":
"string",
-
"error_details":
"string"
}
This is a convenience method to completely or
partially reverse a previous transaction, regardless
of the state which it's currently in. It combines
the functionality of the
/transactions/adjust,
/transactions/void, and
/transactions/refund endpoints.
amount is the amount to reduce
it by, not the new amount). If the amount is
the full amount of the authorization, it will
be voided.
ACH transactions can only be voided until 1am Eastern Time the night after the transaction was processed, and can only be refunded after 5 business days have passed since the transaction was processed.
First Data terminal transactions can only be voided within 25 minutes of the transaction. After that point it will be run as a refund/credit regardless if the transaction is settled.
Terminal transactions cannot be adjusted, and will always run as a refund if a different amount is sent regardless if the transaction is settled.
ACH transactions cannot be adjusted, and will return an error if a different amount is sent and they are unsettled.
This endpoint requires that the source key have a pin, and requires the following permissions on the source key:
TSYS only supports voids/adjusts on transactions using US or Canadian cards. International cards must use refunds.
Terminal full reversals that are processed on a
different terminal (by specifying
terminal_id) will be processed as a
refund, instead of an void.
Terminals with connected refunds will behave as matched refunds.
|
reference_number
required
|
integer
>= 1
Reference number of the transaction to reverse. |
| terminal_id |
string
The serial number of the terminal. This must match a terminal that is boarded in the gateway. By default the reversal transaction will process on the terminal that the original transaction was processed on. To specify a different terminal, this field can be set. If a different terminal is set, a void will run as a refund. |
| amount |
number
[ 0.01 .. 20000000 ]
Amount of original transaction to reverse. |
|
object
(BaseTransactionCustomer)
|
|
|
object
(BaseTransactionDetails)
Additional optional transaction details. |
{
-
"reference_number":
1,
-
"terminal_id":
"string",
-
"amount":
0.01,
-
"customer":
{
-
"send_receipt":
false,
-
"email":
"string",
-
"fax":
"string",
-
"identifier":
"string"
},
-
"transaction_details":
{
-
"description":
"string",
-
"clerk":
"string",
-
"terminal":
"string",
-
"client_ip":
"string",
-
"signature":
"string"
}
}
{
-
"version":
"string",
-
"status":
"Approved",
-
"status_code":
"A",
-
"error_message":
"string",
-
"error_code":
"string",
-
"error_details":
"string",
-
"type":
"Void"
}
Returns the surcharge that will be automatically applied when processing a transaction using the specified payment source (e.g. a card number).
|
source_type
required
|
string
Enum:
"card"
"tkn"
"pm"
"ref"
|
|
source
required
|
string
<= 16 characters
[A-Za-z0-9]+
The source to return the surcharge details for. This can be a card, a token, a payment method ID or the reference number of a previous transaction.
For a source type of |
{
-
"source_type":
"card",
-
"source":
"string"
}
{
-
"surcharge":
{
-
"type":
"percent",
-
"value":
0
},
-
"bin_type":
"C",
-
"payment_type":
"card"
}
Returns a paginated list of all batches.
| order |
string
Default:
"asc"
Enum:
"asc"
"desc"
The sort order. |
| status |
string
Enum:
"open"
"closed"
The status of the batch. |
|
integer or string
The earliest date to search. This will be rounded down to the beginning of the day in UTC. |
|
|
integer or string
The latest date to search. This will be rounded up to the end of the day in UTC. |
|
| limit |
integer
[ 1 .. 100 ]
Default:
10
The maximum number of results to return. |
| offset |
integer
>= 0
The 0-based offset to start from. |
[
-
{
-
"id":
1,
-
"opened_at":
null,
-
"auto_close_date":
null,
-
"closed_at":
null,
-
"platform":
"north",
-
"charges_sum":
0.01,
-
"charges_count":
1,
-
"credits_sum":
0.01,
-
"credits_count":
1,
-
"transactions_count":
1
}
]
Get a single batch by batch ID.
|
id
required
|
integer
>= 1
The batch ID. |
{
-
"id":
1,
-
"opened_at":
null,
-
"auto_close_date":
null,
-
"closed_at":
null,
-
"platform":
"north",
-
"charges_sum":
0.01,
-
"charges_count":
1,
-
"credits_sum":
0.01,
-
"credits_count":
1,
-
"transactions_count":
1
}
Get the transactions in the specified batch.
|
id
required
|
integer
>= 1
The batch ID. |
| order |
string
Default:
"asc"
Enum:
"asc"
"desc"
The sort order. |
| status |
Array of strings
Items Enum:
"captured"
"pending"
"reserve"
"originated"
"returned"
"cancelled"
"queued"
"declined"
"error"
"settled"
"voided"
"approved"
"blocked"
"expired"
The transaction status(es) to filter by. Multiple values can be sent, separated by commas. |
| payment_type |
Array of strings
Items Enum:
"credit_card"
"check"
The transaction payment type(s) to filter by. Multiple values can be sent, separated by commas. |
| settled_date |
string
<date>
The settled date in UTC to filter for.
This will exclude transactions processed
more than 30 days before the specified
settlement date, regardless of the
|
| date_field |
string
Default:
"created_at"
Enum:
"settled_at"
"created_at"
The date event to filter by. This field
only has an effect when combined with
|
|
integer or string
The earliest date to search. This will be rounded down to the beginning of the day in UTC. |
|
|
integer or string
The latest date to search. This will be rounded up to the end of the day in UTC. |
|
| limit |
integer
[ 1 .. 100 ]
Default:
10
The maximum number of results to return. |
| offset |
integer
>= 0
The 0-based offset to start from. |
[
-
{
-
"id":
1,
-
"created_at":
"2019-08-24T14:15:22Z",
-
"settled_date":
"2019-08-24",
-
"amount_details":
{
-
"amount":
0.01,
-
"tax":
0,
-
"surcharge":
0,
-
"shipping":
0,
-
"tip":
0,
-
"discount":
0,
-
"subtotal":
0,
-
"original_requested_amount":
0.01,
-
"original_authorized_amount":
0.01
},
-
"transaction_details":
{
-
"description":
"string",
-
"clerk":
"string",
-
"terminal":
"string",
-
"client_ip":
"string",
-
"signature":
"string",
-
"invoice_number":
"string",
-
"po_number":
"string",
-
"order_number":
"string",
-
"batch_id":
1,
-
"source":
"string",
-
"terminal_name":
"string",
-
"terminal_id":
"string",
-
"username":
"string",
-
"type":
"charge",
-
"reference_number":
1,
-
"schedule_id":
0
},
-
"customer":
{
-
"identifier":
"string",
-
"email":
"string",
-
"fax":
"string",
-
"customer_id":
1
},
-
"status_details":
{
-
"error_code":
"string",
-
"error_message":
"string",
-
"status":
"captured"
},
-
"billing_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"shipping_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"custom_fields":
{
-
"custom1":
"string",
-
"custom2":
"string",
-
"custom3":
"string",
-
"custom4":
"string",
-
"custom5":
"string",
-
"custom6":
"string",
-
"custom7":
"string",
-
"custom8":
"string",
-
"custom9":
"string",
-
"custom10":
"string",
-
"custom11":
"string",
-
"custom12":
"string",
-
"custom13":
"string",
-
"custom14":
"string",
-
"custom15":
"string",
-
"custom16":
"string",
-
"custom17":
"string",
-
"custom18":
"string",
-
"custom19":
"string",
-
"custom20":
"string"
},
-
"card_details":
{
-
"name":
"string",
-
"last4":
"stri",
-
"expiry_month":
1,
-
"expiry_year":
2020,
-
"card_type":
"Visa",
-
"avs_street":
"string",
-
"avs_zip":
"string",
-
"auth_code":
"string",
-
"bin":
"string",
-
"bin_details":
{
-
"type":
"C"
},
-
"avs_result":
"string",
-
"avs_result_code":
"YYY",
-
"cvv_result":
"string",
-
"cvv_result_code":
"M",
-
"cavv_result":
"string",
-
"cavv_result_code":
"string"
}
}
]
Returns an array of transactions
| order |
string
Default:
"asc"
Enum:
"asc"
"desc"
The sort order. |
| status |
Array of strings
Items Enum:
"captured"
"pending"
"reserve"
"originated"
"returned"
"cancelled"
"queued"
"declined"
"error"
"settled"
"voided"
"approved"
"blocked"
"expired"
The transaction status(es) to filter by. Multiple values can be sent, separated by commas. |
| payment_type |
Array of strings
Items Enum:
"credit_card"
"check"
The transaction payment type(s) to filter by. Multiple values can be sent, separated by commas. |
| settled_date |
string
<date>
The settled date in UTC to filter for.
This will exclude transactions processed
more than 30 days before the specified
settlement date, regardless of the
|
| date_field |
string
Default:
"created_at"
Enum:
"settled_at"
"created_at"
The date event to filter by. This field
only has an effect when combined with
|
|
integer or string
The earliest date to search. This will be rounded down to the beginning of the day in UTC. |
|
|
integer or string
The latest date to search. This will be rounded up to the end of the day in UTC. |
|
| limit |
integer
[ 1 .. 100 ]
Default:
10
The maximum number of results to return. |
| offset |
integer
>= 0
The 0-based offset to start from. |
[
-
{
-
"id":
1,
-
"created_at":
"2019-08-24T14:15:22Z",
-
"settled_date":
"2019-08-24",
-
"amount_details":
{
-
"amount":
0.01,
-
"tax":
0,
-
"surcharge":
0,
-
"shipping":
0,
-
"tip":
0,
-
"discount":
0,
-
"subtotal":
0,
-
"original_requested_amount":
0.01,
-
"original_authorized_amount":
0.01
},
-
"transaction_details":
{
-
"description":
"string",
-
"clerk":
"string",
-
"terminal":
"string",
-
"client_ip":
"string",
-
"signature":
"string",
-
"invoice_number":
"string",
-
"po_number":
"string",
-
"order_number":
"string",
-
"batch_id":
1,
-
"source":
"string",
-
"terminal_name":
"string",
-
"terminal_id":
"string",
-
"username":
"string",
-
"type":
"charge",
-
"reference_number":
1,
-
"schedule_id":
0
},
-
"customer":
{
-
"identifier":
"string",
-
"email":
"string",
-
"fax":
"string",
-
"customer_id":
1
},
-
"status_details":
{
-
"error_code":
"string",
-
"error_message":
"string",
-
"status":
"captured"
},
-
"billing_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"shipping_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"custom_fields":
{
-
"custom1":
"string",
-
"custom2":
"string",
-
"custom3":
"string",
-
"custom4":
"string",
-
"custom5":
"string",
-
"custom6":
"string",
-
"custom7":
"string",
-
"custom8":
"string",
-
"custom9":
"string",
-
"custom10":
"string",
-
"custom11":
"string",
-
"custom12":
"string",
-
"custom13":
"string",
-
"custom14":
"string",
-
"custom15":
"string",
-
"custom16":
"string",
-
"custom17":
"string",
-
"custom18":
"string",
-
"custom19":
"string",
-
"custom20":
"string"
},
-
"card_details":
{
-
"name":
"string",
-
"last4":
"stri",
-
"expiry_month":
1,
-
"expiry_year":
2020,
-
"card_type":
"Visa",
-
"avs_street":
"string",
-
"avs_zip":
"string",
-
"auth_code":
"string",
-
"bin":
"string",
-
"bin_details":
{
-
"type":
"C"
},
-
"avs_result":
"string",
-
"avs_result_code":
"YYY",
-
"cvv_result":
"string",
-
"cvv_result_code":
"M",
-
"cavv_result":
"string",
-
"cavv_result_code":
"string"
}
}
]
Returns a single transaction by reference number
|
id
required
|
integer
>= 1
The transaction ID. |
{
-
"id":
1,
-
"created_at":
"2019-08-24T14:15:22Z",
-
"settled_date":
"2019-08-24",
-
"amount_details":
{
-
"amount":
0.01,
-
"tax":
0,
-
"surcharge":
0,
-
"shipping":
0,
-
"tip":
0,
-
"discount":
0,
-
"subtotal":
0,
-
"original_requested_amount":
0.01,
-
"original_authorized_amount":
0.01
},
-
"transaction_details":
{
-
"description":
"string",
-
"clerk":
"string",
-
"terminal":
"string",
-
"client_ip":
"string",
-
"signature":
"string",
-
"invoice_number":
"string",
-
"po_number":
"string",
-
"order_number":
"string",
-
"batch_id":
1,
-
"source":
"string",
-
"terminal_name":
"string",
-
"terminal_id":
"string",
-
"username":
"string",
-
"type":
"charge",
-
"reference_number":
1,
-
"schedule_id":
0
},
-
"customer":
{
-
"identifier":
"string",
-
"email":
"string",
-
"fax":
"string",
-
"customer_id":
1
},
-
"status_details":
{
-
"error_code":
"string",
-
"error_message":
"string",
-
"status":
"captured"
},
-
"billing_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"shipping_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"custom_fields":
{
-
"custom1":
"string",
-
"custom2":
"string",
-
"custom3":
"string",
-
"custom4":
"string",
-
"custom5":
"string",
-
"custom6":
"string",
-
"custom7":
"string",
-
"custom8":
"string",
-
"custom9":
"string",
-
"custom10":
"string",
-
"custom11":
"string",
-
"custom12":
"string",
-
"custom13":
"string",
-
"custom14":
"string",
-
"custom15":
"string",
-
"custom16":
"string",
-
"custom17":
"string",
-
"custom18":
"string",
-
"custom19":
"string",
-
"custom20":
"string"
},
-
"card_details":
{
-
"name":
"string",
-
"last4":
"stri",
-
"expiry_month":
1,
-
"expiry_year":
2020,
-
"card_type":
"Visa",
-
"avs_street":
"string",
-
"avs_zip":
"string",
-
"auth_code":
"string",
-
"bin":
"string",
-
"bin_details":
{
-
"type":
"C"
},
-
"avs_result":
"string",
-
"avs_result_code":
"YYY",
-
"cvv_result":
"string",
-
"cvv_result_code":
"M",
-
"cavv_result":
"string",
-
"cavv_result_code":
"string"
}
}
Save a card number for future use. A token will be returned, which can be used later in place of a card number.
This will not verify that the card is valid. It is
recommended to instead use a
Verification request, and set the save_card property to
true. This will run a Verification
transaction to verify that the card is valid, and
return a token in the response.
|
card
required
|
string
[ 14 .. 16 ] characters
^\d+$
Card number |
|
expiry_month
required
|
integer
[ 1 .. 12 ]
Card expiration month |
|
expiry_year
required
|
integer
[ 2020 .. 9999 ]
Card expiration year |
{
-
"card":
"stringstringst",
-
"expiry_month":
1,
-
"expiry_year":
2020
}
{
-
"cardRef":
"stringstringstri"
}
Updates a saved card's expiration by Card Ref
|
cardRef
required
|
string
>= 1
The card ref. |
| expiry_month |
integer
[ 1 .. 12 ]
Card expiration month |
| expiry_year |
integer
[ 2020 .. 9999 ]
Card expiration year |
{
-
"expiry_month":
1,
-
"expiry_year":
2020
}
{
-
"expiry_month":
1,
-
"expiry_year":
2020,
-
"cardRef":
"string"
}
Returns an array of customers
| order |
string
Default:
"asc"
Enum:
"asc"
"desc"
The sort order. |
| limit |
integer
[ 1 .. 100 ]
Default:
10
The maximum number of results to return. |
| offset |
integer
>= 0
The 0-based offset to start from. |
| active |
boolean
The status of the customer. |
| customer_number |
string
The |
[
-
{
-
"identifier":
"string",
-
"customer_number":
"string",
-
"first_name":
"string",
-
"last_name":
"string",
-
"email":
"string",
-
"website":
"string",
-
"phone":
"string",
-
"alternate_phone":
"string",
-
"billing_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"shipping_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"active":
true,
-
"id":
1
}
]
|
identifier
required
|
string
<= 255 characters
Something that identifies the customer, e.g. the customer's name or company. |
| customer_number |
string
<= 255 characters
A custom identifier. |
| first_name |
string
<= 255 characters
|
| last_name |
string
<= 255 characters
|
|
string
<emails>
<= 255 characters
|
|
| website |
string
<= 255 characters
|
| phone |
string
<= 255 characters
|
| alternate_phone |
string
<= 255 characters
|
|
object
(Address)
|
|
|
object
(Address)
|
|
| active |
boolean
Default:
true
|
{
-
"identifier":
"string",
-
"customer_number":
"string",
-
"first_name":
"string",
-
"last_name":
"string",
-
"email":
"string",
-
"website":
"string",
-
"phone":
"string",
-
"alternate_phone":
"string",
-
"billing_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"shipping_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"active":
true
}
{
-
"identifier":
"string",
-
"customer_number":
"string",
-
"first_name":
"string",
-
"last_name":
"string",
-
"email":
"string",
-
"website":
"string",
-
"phone":
"string",
-
"alternate_phone":
"string",
-
"billing_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"shipping_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"active":
true,
-
"id":
1
}
This will create a new customer using the information from the referenced transaction. A payment method can subsequently be created using the transaction as the source. Any field provided in the body will override the data from the transaction. A new customer will be created even if the transaction is already linked to an existing customer. If the transaction is not already linked to a customer, it will be linked to the newly created customer.
|
reference_number
required
|
integer
>= 1
Reference number for the transaction. |
| identifier |
string
<= 255 characters
Something that identifies the customer, e.g. the customer's name or company. |
| customer_number |
string
<= 255 characters
A custom identifier. |
| first_name |
string
<= 255 characters
|
| last_name |
string
<= 255 characters
|
|
string
<emails>
<= 255 characters
|
|
| website |
string
<= 255 characters
|
| phone |
string
<= 255 characters
|
| alternate_phone |
string
<= 255 characters
|
|
object
(Address)
|
|
|
object
(Address)
|
|
| active |
boolean
Default:
true
|
{
-
"identifier":
"string",
-
"customer_number":
"string",
-
"first_name":
"string",
-
"last_name":
"string",
-
"email":
"string",
-
"website":
"string",
-
"phone":
"string",
-
"alternate_phone":
"string",
-
"billing_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"shipping_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"active":
true,
-
"reference_number":
1
}
{
-
"identifier":
"string",
-
"customer_number":
"string",
-
"first_name":
"string",
-
"last_name":
"string",
-
"email":
"string",
-
"website":
"string",
-
"phone":
"string",
-
"alternate_phone":
"string",
-
"billing_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"shipping_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"active":
true,
-
"id":
1
}
Returns a single customers by ID number
|
id
required
|
integer
>= 1
The customer ID. |
{
-
"identifier":
"string",
-
"customer_number":
"string",
-
"first_name":
"string",
-
"last_name":
"string",
-
"email":
"string",
-
"website":
"string",
-
"phone":
"string",
-
"alternate_phone":
"string",
-
"billing_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"shipping_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"active":
true,
-
"id":
1
}
Updates a single customer by ID number
|
id
required
|
integer
>= 1
The customer ID. |
| identifier |
string
<= 255 characters
Something that identifies the customer, e.g. the customer's name or company. |
| customer_number |
string
<= 255 characters
A custom identifier. |
| first_name |
string
<= 255 characters
|
| last_name |
string
<= 255 characters
|
|
string
<emails>
<= 255 characters
|
|
| website |
string
<= 255 characters
|
| phone |
string
<= 255 characters
|
| alternate_phone |
string
<= 255 characters
|
|
object
(Address)
|
|
|
object
(Address)
|
|
| active |
boolean
Default:
true
|
{
-
"identifier":
"string",
-
"customer_number":
"string",
-
"first_name":
"string",
-
"last_name":
"string",
-
"email":
"string",
-
"website":
"string",
-
"phone":
"string",
-
"alternate_phone":
"string",
-
"billing_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"shipping_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"active":
true
}
{
-
"identifier":
"string",
-
"customer_number":
"string",
-
"first_name":
"string",
-
"last_name":
"string",
-
"email":
"string",
-
"website":
"string",
-
"phone":
"string",
-
"alternate_phone":
"string",
-
"billing_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"shipping_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"active":
true,
-
"id":
1
}
Returns the payment methods for the specified customer
|
id
required
|
integer
>= 1
The customer ID. |
[
-
{
-
"id":
1,
-
"customer_id":
1,
-
"created_at":
"2019-08-24T14:15:22Z",
-
"avs_address":
"string",
-
"avs_zip":
"string",
-
"name":
"string",
-
"expiry_month":
1,
-
"expiry_year":
2020,
-
"payment_method_type":
"card",
-
"card_type":
"Visa",
-
"bin":
"string",
-
"bin_details":
{
-
"type":
"C"
},
-
"last4":
"stri"
}
]
Creates a payment method for the specified customer.
|
id
required
|
integer
>= 1
The customer ID. |
|
card
required
|
string
[ 14 .. 16 ] characters
^\d+$
Card number |
|
expiry_month
required
|
integer
[ 1 .. 12 ]
|
|
expiry_year
required
|
integer
[ 2020 .. 9999 ]
|
| avs_address |
string
<= 255 characters
Billing address for the card. |
| avs_zip |
string
<= 50 characters
Billing zip code for the card. While not required, this field should be populated for fraud prevention and to obtain the best rate for E-commerce credit card transactions. |
| name |
string
<= 255 characters
The name on the account. |
{
-
"avs_address":
"string",
-
"avs_zip":
"string",
-
"name":
"string",
-
"expiry_month":
1,
-
"expiry_year":
2020,
-
"card":
"stringstringst"
}
{
-
"id":
1,
-
"customer_id":
1,
-
"created_at":
"2019-08-24T14:15:22Z",
-
"avs_address":
"string",
-
"avs_zip":
"string",
-
"name":
"string",
-
"expiry_month":
1,
-
"expiry_year":
2020,
-
"payment_method_type":
"card",
-
"card_type":
"Visa",
-
"bin":
"string",
-
"bin_details":
{
-
"type":
"C"
},
-
"last4":
"stri"
}
Returns the recurring schedules for the specified customer
|
id
required
|
integer
>= 1
The customer ID. |
[
-
{
-
"title":
"string",
-
"frequency":
"daily",
-
"amount":
0.01,
-
"next_run_date":
"2019-08-24",
-
"num_left":
0,
-
"payment_method_id":
1,
-
"active":
true,
-
"receipt_email":
"string",
-
"status":
"active",
-
"prev_run_date":
"2019-08-24",
-
"transaction_count":
0,
-
"id":
1,
-
"customer_id":
1,
-
"created_at":
"2019-08-24T14:15:22Z"
}
]
Creates a recurring schedule for the specified customer.
|
id
required
|
integer
>= 1
The customer ID. |
|
title
required
|
string
<= 255 characters
|
|
amount
required
|
number
[ 0.01 .. 20000000 ]
Amount to bill. If a mandatory surcharge is set by the ISO/MSP, the actual amount charged could be different than the amount submitted in this field. |
|
payment_method_id
required
|
integer
>= 1
Payment method ID |
| frequency |
string
Default:
"monthly"
Enum:
"daily"
"weekly"
"biweekly"
"monthly"
"bimonthly"
"quarterly"
"biannually"
"annually"
|
| next_run_date |
string
<date>
Next date (in EST) that the schedule will run. This must be after today's date. The default is tomorrow in EST. |
| num_left |
integer
>= 0
Default:
0
Number of times the schedule has left to
bill. Set to |
| active |
boolean
Default:
true
|
| receipt_email |
string
<emails>
<= 255 characters
An email address to send a customer receipt to each time the schedule runs. |
| use_this_source_key |
boolean
Default:
false
By default, recurring transactions use the
|
{
-
"title":
"string",
-
"frequency":
"daily",
-
"amount":
0.01,
-
"next_run_date":
"2019-08-24",
-
"num_left":
0,
-
"payment_method_id":
1,
-
"active":
true,
-
"receipt_email":
"string",
-
"use_this_source_key":
false
}
{
-
"title":
"string",
-
"frequency":
"daily",
-
"amount":
0.01,
-
"next_run_date":
"2019-08-24",
-
"num_left":
0,
-
"payment_method_id":
1,
-
"active":
true,
-
"receipt_email":
"string",
-
"status":
"active",
-
"prev_run_date":
"2019-08-24",
-
"transaction_count":
0,
-
"id":
1,
-
"customer_id":
1,
-
"created_at":
"2019-08-24T14:15:22Z"
}
Get the transactions for the specified customer.
|
id
required
|
integer
>= 1
The customer ID. |
| order |
string
Default:
"asc"
Enum:
"asc"
"desc"
The sort order. |
| status |
Array of strings
Items Enum:
"captured"
"pending"
"reserve"
"originated"
"returned"
"cancelled"
"queued"
"declined"
"error"
"settled"
"voided"
"approved"
"blocked"
"expired"
The transaction status(es) to filter by. Multiple values can be sent, separated by commas. |
| payment_type |
Array of strings
Items Enum:
"credit_card"
"check"
The transaction payment type(s) to filter by. Multiple values can be sent, separated by commas. |
| settled_date |
string
<date>
The settled date in UTC to filter for.
This will exclude transactions processed
more than 30 days before the specified
settlement date, regardless of the
|
| date_field |
string
Default:
"created_at"
Enum:
"settled_at"
"created_at"
The date event to filter by. This field
only has an effect when combined with
|
|
integer or string
The earliest date to search. This will be rounded down to the beginning of the day in UTC. |
|
|
integer or string
The latest date to search. This will be rounded up to the end of the day in UTC. |
|
| limit |
integer
[ 1 .. 100 ]
Default:
10
The maximum number of results to return. |
| offset |
integer
>= 0
The 0-based offset to start from. |
[
-
{
-
"id":
1,
-
"created_at":
"2019-08-24T14:15:22Z",
-
"settled_date":
"2019-08-24",
-
"amount_details":
{
-
"amount":
0.01,
-
"tax":
0,
-
"surcharge":
0,
-
"shipping":
0,
-
"tip":
0,
-
"discount":
0,
-
"subtotal":
0,
-
"original_requested_amount":
0.01,
-
"original_authorized_amount":
0.01
},
-
"transaction_details":
{
-
"description":
"string",
-
"clerk":
"string",
-
"terminal":
"string",
-
"client_ip":
"string",
-
"signature":
"string",
-
"invoice_number":
"string",
-
"po_number":
"string",
-
"order_number":
"string",
-
"batch_id":
1,
-
"source":
"string",
-
"terminal_name":
"string",
-
"terminal_id":
"string",
-
"username":
"string",
-
"type":
"charge",
-
"reference_number":
1,
-
"schedule_id":
0
},
-
"customer":
{
-
"identifier":
"string",
-
"email":
"string",
-
"fax":
"string",
-
"customer_id":
1
},
-
"status_details":
{
-
"error_code":
"string",
-
"error_message":
"string",
-
"status":
"captured"
},
-
"billing_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"shipping_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"custom_fields":
{
-
"custom1":
"string",
-
"custom2":
"string",
-
"custom3":
"string",
-
"custom4":
"string",
-
"custom5":
"string",
-
"custom6":
"string",
-
"custom7":
"string",
-
"custom8":
"string",
-
"custom9":
"string",
-
"custom10":
"string",
-
"custom11":
"string",
-
"custom12":
"string",
-
"custom13":
"string",
-
"custom14":
"string",
-
"custom15":
"string",
-
"custom16":
"string",
-
"custom17":
"string",
-
"custom18":
"string",
-
"custom19":
"string",
-
"custom20":
"string"
},
-
"card_details":
{
-
"name":
"string",
-
"last4":
"stri",
-
"expiry_month":
1,
-
"expiry_year":
2020,
-
"card_type":
"Visa",
-
"avs_street":
"string",
-
"avs_zip":
"string",
-
"auth_code":
"string",
-
"bin":
"string",
-
"bin_details":
{
-
"type":
"C"
},
-
"avs_result":
"string",
-
"avs_result_code":
"YYY",
-
"cvv_result":
"string",
-
"cvv_result_code":
"M",
-
"cavv_result":
"string",
-
"cavv_result_code":
"string"
}
}
]
Returns a paginated list of all payment methods.
| order |
string
Default:
"asc"
Enum:
"asc"
"desc"
The sort order. |
| limit |
integer
[ 1 .. 100 ]
Default:
10
The maximum number of results to return. |
| offset |
integer
>= 0
The 0-based offset to start from. |
[
-
{
-
"id":
1,
-
"customer_id":
1,
-
"created_at":
"2019-08-24T14:15:22Z",
-
"avs_address":
"string",
-
"avs_zip":
"string",
-
"name":
"string",
-
"expiry_month":
1,
-
"expiry_year":
2020,
-
"payment_method_type":
"card",
-
"card_type":
"Visa",
-
"bin":
"string",
-
"bin_details":
{
-
"type":
"C"
},
-
"last4":
"stri"
}
]
Get a single payment method by payment method ID.
|
id
required
|
integer
>= 1
The payment method ID. |
{
-
"id":
1,
-
"customer_id":
1,
-
"created_at":
"2019-08-24T14:15:22Z",
-
"avs_address":
"string",
-
"avs_zip":
"string",
-
"name":
"string",
-
"expiry_month":
1,
-
"expiry_year":
2020,
-
"payment_method_type":
"card",
-
"card_type":
"Visa",
-
"bin":
"string",
-
"bin_details":
{
-
"type":
"C"
},
-
"last4":
"stri"
}
Updates a payment method by ID number
|
id
required
|
integer
>= 1
The payment method ID. |
| avs_address |
string
<= 255 characters
Billing address for the card. |
| avs_zip |
string
<= 50 characters
Billing zip code for the card. While not required, this field should be populated for fraud prevention and to obtain the best rate for E-commerce credit card transactions. |
| name |
string
<= 255 characters
The name on the account. |
| expiry_month |
integer
[ 1 .. 12 ]
|
| expiry_year |
integer
[ 2020 .. 9999 ]
|
{
-
"avs_address":
"string",
-
"avs_zip":
"string",
-
"name":
"string",
-
"expiry_month":
1,
-
"expiry_year":
2020
}
{
-
"id":
1,
-
"customer_id":
1,
-
"created_at":
"2019-08-24T14:15:22Z",
-
"avs_address":
"string",
-
"avs_zip":
"string",
-
"name":
"string",
-
"expiry_month":
1,
-
"expiry_year":
2020,
-
"payment_method_type":
"card",
-
"card_type":
"Visa",
-
"bin":
"string",
-
"bin_details":
{
-
"type":
"C"
},
-
"last4":
"stri"
}
Returns the recurring schedules for the specified payment method
|
id
required
|
integer
>= 1
The payment method ID. |
{
-
"title":
"string",
-
"frequency":
"daily",
-
"amount":
0.01,
-
"next_run_date":
"2019-08-24",
-
"num_left":
0,
-
"payment_method_id":
1,
-
"active":
true,
-
"receipt_email":
"string",
-
"status":
"active",
-
"prev_run_date":
"2019-08-24",
-
"transaction_count":
0,
-
"id":
1,
-
"customer_id":
1,
-
"created_at":
"2019-08-24T14:15:22Z"
}
Returns a paginated list of all recurring schedules.
| order |
string
Default:
"asc"
Enum:
"asc"
"desc"
The sort order. |
| limit |
integer
[ 1 .. 100 ]
Default:
10
The maximum number of results to return. |
| offset |
integer
>= 0
The 0-based offset to start from. |
[
-
{
-
"title":
"string",
-
"frequency":
"daily",
-
"amount":
0.01,
-
"next_run_date":
"2019-08-24",
-
"num_left":
0,
-
"payment_method_id":
1,
-
"active":
true,
-
"receipt_email":
"string",
-
"status":
"active",
-
"prev_run_date":
"2019-08-24",
-
"transaction_count":
0,
-
"id":
1,
-
"customer_id":
1,
-
"created_at":
"2019-08-24T14:15:22Z"
}
]
Get a single recurring schedules by ID.
|
id
required
|
integer
>= 1
The recurring schedule ID. |
{
-
"title":
"string",
-
"frequency":
"daily",
-
"amount":
0.01,
-
"next_run_date":
"2019-08-24",
-
"num_left":
0,
-
"payment_method_id":
1,
-
"active":
true,
-
"receipt_email":
"string",
-
"status":
"active",
-
"prev_run_date":
"2019-08-24",
-
"transaction_count":
0,
-
"id":
1,
-
"customer_id":
1,
-
"created_at":
"2019-08-24T14:15:22Z"
}
Updates a recurring schedule by ID number
|
id
required
|
integer
>= 1
The recurring schedule ID. |
| title |
string
<= 255 characters
|
| frequency |
string
Default:
"monthly"
Enum:
"daily"
"weekly"
"biweekly"
"monthly"
"bimonthly"
"quarterly"
"biannually"
"annually"
|
| amount |
number
[ 0.01 .. 20000000 ]
Amount to bill. If a mandatory surcharge is set by the ISO/MSP, the actual amount charged could be different than the amount submitted in this field. |
| next_run_date |
string
<date>
Next date (in EST) that the schedule will run. This must be after today's date. The default is tomorrow in EST. |
| num_left |
integer
>= 0
Default:
0
Number of times the schedule has left to
bill. Set to |
| payment_method_id |
integer
>= 1
Payment method ID |
| active |
boolean
Default:
true
|
| receipt_email |
string
<emails>
<= 255 characters
An email address to send a customer receipt to each time the schedule runs. |
{
-
"title":
"string",
-
"frequency":
"daily",
-
"amount":
0.01,
-
"next_run_date":
"2019-08-24",
-
"num_left":
0,
-
"payment_method_id":
1,
-
"active":
true,
-
"receipt_email":
"string"
}
{
-
"title":
"string",
-
"frequency":
"daily",
-
"amount":
0.01,
-
"next_run_date":
"2019-08-24",
-
"num_left":
0,
-
"payment_method_id":
1,
-
"active":
true,
-
"receipt_email":
"string",
-
"status":
"active",
-
"prev_run_date":
"2019-08-24",
-
"transaction_count":
0,
-
"id":
1,
-
"customer_id":
1,
-
"created_at":
"2019-08-24T14:15:22Z"
}
|
id
required
|
integer
>= 1
The recurring schedule ID. |
| order |
string
Default:
"asc"
Enum:
"asc"
"desc"
The sort order. |
| status |
Array of strings
Items Enum:
"captured"
"pending"
"reserve"
"originated"
"returned"
"cancelled"
"queued"
"declined"
"error"
"settled"
"voided"
"approved"
"blocked"
"expired"
The transaction status(es) to filter by. Multiple values can be sent, separated by commas. |
| payment_type |
Array of strings
Items Enum:
"credit_card"
"check"
The transaction payment type(s) to filter by. Multiple values can be sent, separated by commas. |
| settled_date |
string
<date>
The settled date in UTC to filter for.
This will exclude transactions processed
more than 30 days before the specified
settlement date, regardless of the
|
| date_field |
string
Default:
"created_at"
Enum:
"settled_at"
"created_at"
The date event to filter by. This field
only has an effect when combined with
|
|
integer or string
The earliest date to search. This will be rounded down to the beginning of the day in UTC. |
|
|
integer or string
The latest date to search. This will be rounded up to the end of the day in UTC. |
|
| limit |
integer
[ 1 .. 100 ]
Default:
10
The maximum number of results to return. |
| offset |
integer
>= 0
The 0-based offset to start from. |
[
-
{
-
"id":
1,
-
"created_at":
"2019-08-24T14:15:22Z",
-
"settled_date":
"2019-08-24",
-
"amount_details":
{
-
"amount":
0.01,
-
"tax":
0,
-
"surcharge":
0,
-
"shipping":
0,
-
"tip":
0,
-
"discount":
0,
-
"subtotal":
0,
-
"original_requested_amount":
0.01,
-
"original_authorized_amount":
0.01
},
-
"transaction_details":
{
-
"description":
"string",
-
"clerk":
"string",
-
"terminal":
"string",
-
"client_ip":
"string",
-
"signature":
"string",
-
"invoice_number":
"string",
-
"po_number":
"string",
-
"order_number":
"string",
-
"batch_id":
1,
-
"source":
"string",
-
"terminal_name":
"string",
-
"terminal_id":
"string",
-
"username":
"string",
-
"type":
"charge",
-
"reference_number":
1,
-
"schedule_id":
0
},
-
"customer":
{
-
"identifier":
"string",
-
"email":
"string",
-
"fax":
"string",
-
"customer_id":
1
},
-
"status_details":
{
-
"error_code":
"string",
-
"error_message":
"string",
-
"status":
"captured"
},
-
"billing_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"shipping_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"custom_fields":
{
-
"custom1":
"string",
-
"custom2":
"string",
-
"custom3":
"string",
-
"custom4":
"string",
-
"custom5":
"string",
-
"custom6":
"string",
-
"custom7":
"string",
-
"custom8":
"string",
-
"custom9":
"string",
-
"custom10":
"string",
-
"custom11":
"string",
-
"custom12":
"string",
-
"custom13":
"string",
-
"custom14":
"string",
-
"custom15":
"string",
-
"custom16":
"string",
-
"custom17":
"string",
-
"custom18":
"string",
-
"custom19":
"string",
-
"custom20":
"string"
},
-
"card_details":
{
-
"name":
"string",
-
"last4":
"stri",
-
"expiry_month":
1,
-
"expiry_year":
2020,
-
"card_type":
"Visa",
-
"avs_street":
"string",
-
"avs_zip":
"string",
-
"auth_code":
"string",
-
"bin":
"string",
-
"bin_details":
{
-
"type":
"C"
},
-
"avs_result":
"string",
-
"avs_result_code":
"YYY",
-
"cvv_result":
"string",
-
"cvv_result_code":
"M",
-
"cavv_result":
"string",
-
"cavv_result_code":
"string"
}
}
]
Returns a list of all products.
| order |
string
Default:
"asc"
Enum:
"asc"
"desc"
The sort order. |
| limit |
integer
[ 1 .. 100 ]
Default:
10
The maximum number of results to return. |
| offset |
integer
>= 0
The 0-based offset to start from. |
| selected_fields |
Array of strings
An array of fields to return. Defaults to all available fields. |
| filter_fields |
Array of strings
An array of fields to search, used together with filter_string. Defaults to all selected fields. |
| filter_string |
string
The string to search for in all fields specified in filter_fields. |
| category_id |
Array of integers
An array of category ids to filter products by. Defaults to all categories. |
[
-
{
-
"id":
0,
-
"quantity_on_order":
0,
-
"created_at":
"2019-08-24T14:15:22Z",
-
"enabled":
true,
-
"name":
"string",
-
"manufacturer":
"string",
-
"model":
"string",
-
"sku":
"string",
-
"upc":
"string",
-
"weight":
"string",
-
"url":
"string",
-
"description":
"string",
-
"price":
0.0001,
-
"category_id":
0,
-
"enabled_from_date":
"2019-08-24",
-
"ship_weight":
"string",
-
"sale_price":
0.0001,
-
"quantity_on_hand":
0,
-
"min_quantity":
1
}
]
|
price
required
|
number
[ 0.0001 .. 20000000 ]
The price of the product. |
| enabled |
boolean
Default:
true
If the product is currently enabled. |
| name |
string
<= 255 characters
The name of the product. |
| manufacturer |
string
[ 1 .. 255 ] characters
The name of the manufacturer. |
| model |
string
[ 1 .. 255 ] characters
The model name. |
| sku |
string
[ 1 .. 255 ] characters
A SKU for the product. |
| upc |
string
[ 1 .. 255 ] characters
A UPC for the product. |
| weight |
string
[ 1 .. 255 ] characters
The product's weight. |
| url |
string
[ 1 .. 255 ] characters
A web url for the product. |
| description |
string
[ 1 .. 255 ] characters
The product description. |
| category_id |
integer
The category that this product belongs in. |
| enabled_from_date |
string
<date>
The date that this product is available. |
| ship_weight |
string
[ 1 .. 255 ] characters
The product's shipping weight. |
| sale_price |
number
[ 0.0001 .. 20000000 ]
The sale price of the product. |
|
integer or null
How many of this product still remains in
stock. Set to |
|
| min_quantity |
integer
Default:
1
Minimum purchase quantity. |
{
-
"enabled":
true,
-
"name":
"string",
-
"manufacturer":
"string",
-
"model":
"string",
-
"sku":
"string",
-
"upc":
"string",
-
"weight":
"string",
-
"url":
"string",
-
"description":
"string",
-
"price":
0.0001,
-
"category_id":
0,
-
"enabled_from_date":
"2019-08-24",
-
"ship_weight":
"string",
-
"sale_price":
0.0001,
-
"quantity_on_hand":
0,
-
"min_quantity":
1
}
{
-
"id":
0,
-
"quantity_on_order":
0,
-
"created_at":
"2019-08-24T14:15:22Z",
-
"enabled":
true,
-
"name":
"string",
-
"manufacturer":
"string",
-
"model":
"string",
-
"sku":
"string",
-
"upc":
"string",
-
"weight":
"string",
-
"url":
"string",
-
"description":
"string",
-
"price":
0.0001,
-
"category_id":
0,
-
"enabled_from_date":
"2019-08-24",
-
"ship_weight":
"string",
-
"sale_price":
0.0001,
-
"quantity_on_hand":
0,
-
"min_quantity":
1
}
Returns the requested product.
|
id
required
|
integer
>= 1
The product ID. |
{
-
"id":
0,
-
"quantity_on_order":
0,
-
"created_at":
"2019-08-24T14:15:22Z",
-
"enabled":
true,
-
"name":
"string",
-
"manufacturer":
"string",
-
"model":
"string",
-
"sku":
"string",
-
"upc":
"string",
-
"weight":
"string",
-
"url":
"string",
-
"description":
"string",
-
"price":
0.0001,
-
"category_id":
0,
-
"enabled_from_date":
"2019-08-24",
-
"ship_weight":
"string",
-
"sale_price":
0.0001,
-
"quantity_on_hand":
0,
-
"min_quantity":
1
}
|
id
required
|
integer
>= 1
The product ID. |
| enabled |
boolean
Default:
true
If the product is currently enabled. |
| name |
string
<= 255 characters
The name of the product. |
| manufacturer |
string
[ 1 .. 255 ] characters
The name of the manufacturer. |
| model |
string
[ 1 .. 255 ] characters
The model name. |
| sku |
string
[ 1 .. 255 ] characters
A SKU for the product. |
| upc |
string
[ 1 .. 255 ] characters
A UPC for the product. |
| weight |
string
[ 1 .. 255 ] characters
The product's weight. |
| url |
string
[ 1 .. 255 ] characters
A web url for the product. |
| description |
string
[ 1 .. 255 ] characters
The product description. |
| price |
number
[ 0.0001 .. 20000000 ]
The price of the product. |
| category_id |
integer
The category that this product belongs in. |
| enabled_from_date |
string
<date>
The date that this product is available. |
| ship_weight |
string
[ 1 .. 255 ] characters
The product's shipping weight. |
| sale_price |
number
[ 0.0001 .. 20000000 ]
The sale price of the product. |
|
integer or null
How many of this product still remains in
stock. Set to |
|
| min_quantity |
integer
Default:
1
Minimum purchase quantity. |
{
-
"enabled":
true,
-
"name":
"string",
-
"manufacturer":
"string",
-
"model":
"string",
-
"sku":
"string",
-
"upc":
"string",
-
"weight":
"string",
-
"url":
"string",
-
"description":
"string",
-
"price":
0.0001,
-
"category_id":
0,
-
"enabled_from_date":
"2019-08-24",
-
"ship_weight":
"string",
-
"sale_price":
0.0001,
-
"quantity_on_hand":
0,
-
"min_quantity":
1
}
{
-
"id":
0,
-
"quantity_on_order":
0,
-
"created_at":
"2019-08-24T14:15:22Z",
-
"enabled":
true,
-
"name":
"string",
-
"manufacturer":
"string",
-
"model":
"string",
-
"sku":
"string",
-
"upc":
"string",
-
"weight":
"string",
-
"url":
"string",
-
"description":
"string",
-
"price":
0.0001,
-
"category_id":
0,
-
"enabled_from_date":
"2019-08-24",
-
"ship_weight":
"string",
-
"sale_price":
0.0001,
-
"quantity_on_hand":
0,
-
"min_quantity":
1
}
Returns a list of all product categories.
| order |
string
Default:
"asc"
Enum:
"asc"
"desc"
The sort order. |
| limit |
integer
[ 1 .. 100 ]
Default:
10
The maximum number of results to return. |
| offset |
integer
>= 0
The 0-based offset to start from. |
| parent_id |
integer
For subcategories, set this field to the parent category Id. |
[
-
{
-
"id":
0,
-
"name":
"string",
-
"parent_id":
null
}
]
|
name
required
|
string
The name of the category. |
|
integer or null
Default:
null
For subcategories, this field is the parent category ID. |
{
-
"name":
"string",
-
"parent_id":
null
}
{
-
"id":
0,
-
"name":
"string",
-
"parent_id":
null
}
|
id
required
|
integer
>= 1
The category ID. |
| name |
string
The name of the category. |
|
integer or null
Default:
null
For subcategories, this field is the parent category ID. |
{
-
"name":
"string",
-
"parent_id":
null
}
{
-
"id":
0,
-
"name":
"string",
-
"parent_id":
null
}
Returns a list of invoices.
| order |
string
Default:
"asc"
Enum:
"asc"
"desc"
The sort order. |
| order_by |
string
Default:
"id"
Enum:
"id"
"number"
"created"
"customer"
"due"
"amount"
"status"
The column to order by. |
| limit |
integer
[ 1 .. 100 ]
Default:
10
The maximum number of results to return. |
| offset |
integer
>= 0
The 0-based offset to start from. |
| selected_fields |
Array of strings
An array of fields to return. Defaults to all available fields. |
| product_id |
integer
A product ID to filter by. |
| customer_ids |
Array of integers
The customer ID(s) to filter by. Multiple values can be sent, separated by commas. |
| statuses |
Array of strings
Items Enum:
"canceled"
"paid"
"partially paid"
"sent"
"viewed"
"authorized"
"saved"
The invoice status(es) to filter by. Multiple values can be sent, separated by commas. |
| amount |
number
Filter invoices by amount. |
| number |
string
Filter invoices by invoice number. |
| due_date |
string
<date>
Filter invoices by due date. |
| created_date |
string
<date>
Filter invoices by created date. (Note: this is not the invoice date). |
[
-
{
-
"id":
0,
-
"status":
"canceled",
-
"to_email":
"string",
-
"sub_total_amount":
0,
-
"total_amount":
0,
-
"due_amount":
0,
-
"paid_amount":
0,
-
"tax":
0,
-
"created_at":
"2019-08-24T14:15:22Z",
-
"products":
[
-
{
-
"id":
0,
-
"product_id":
null,
-
"name":
"string",
-
"description":
"string",
-
"price":
20000000,
-
"quantity":
0,
-
"tax":
20000000,
-
"surcharge":
0,
-
"subtotal":
0
}
],
-
"payment_link":
"string",
-
"customer_id":
null,
-
"number":
null,
-
"customer_company":
"string",
-
"customer_email":
"string",
-
"billing_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"shipping_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"date":
"2019-08-24",
-
"due_date":
"2019-08-24",
-
"note":
"string",
-
"discount":
{
-
"value":
0,
-
"type":
"percent"
},
-
"requirement":
{
-
"value":
100,
-
"type":
"percent"
},
-
"surcharge":
{
-
"card":
{
-
"value":
0,
-
"type":
"percent"
},
-
"ach":
{
-
"value":
0,
-
"type":
"percent"
}
},
-
"terms":
"string",
-
"action":
"charge"
}
]
|
required
|
Array of objects
(NewInvoiceProduct)
A list of products in the invoice. |
|
integer or null
Default:
null
The customer ID to send the invoice to. Can be NULL if customer is not saved. |
|
|
string or null
Default:
null
The invoice number. Can be alphanumeric. If set to NULL, will increment the highest numeric invoice number. |
|
| customer_company |
string
<= 255 characters
The customer name. If invoice is linked to a customer and this field is omitted, it will be populated from the customer. |
| customer_email |
string
<emails>
<= 255 characters
The customer email. If invoice is linked to a customer and this field is omitted, it will be populated from the customer. |
|
object
The customer billing info. If invoice is linked to a customer and this field is omitted, it will be populated from the customer. |
|
|
object
The customer shipping info. If invoice is linked to a customer and this field is omitted, it will be populated from the customer. |
|
| date |
string
<date>
The invoice date. Defaults to today's date. |
| due_date |
string
<date>
The date the invoice is due. Defaults to 30 days from invoice date. |
| note |
string
A note to attach to the invoice. |
|
object
Optional discount to apply to the invoice pre tax total. |
|
|
object
Total amount that is required with first payment. Defaults to full due amount. |
|
|
object
An optional surcharge to be applied to card or ACH payments. This field will be overwritten if the ISO/MSP sets a mandatory surcharge. |
|
| terms |
string
Additional terms to attach to the invoice. |
| action |
string
Default:
"charge"
Enum:
"charge"
"authorize"
The action to process the invoice. |
| send_invoice |
boolean
Default:
false
Flag to send invoice to immediately send invoice to customer for payment. Set to false to save a draft. |
|
object
(InvoiceEmailInfo)
An object containing information related to sending a customer invoice. |
{
-
"customer_id":
null,
-
"number":
null,
-
"customer_company":
"string",
-
"customer_email":
"string",
-
"billing_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"shipping_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"date":
"2019-08-24",
-
"due_date":
"2019-08-24",
-
"note":
"string",
-
"discount":
{
-
"value":
0,
-
"type":
"percent"
},
-
"requirement":
{
-
"value":
100,
-
"type":
"percent"
},
-
"surcharge":
{
-
"card":
{
-
"value":
0,
-
"type":
"percent"
},
-
"ach":
{
-
"value":
0,
-
"type":
"percent"
}
},
-
"terms":
"string",
-
"action":
"charge",
-
"products":
[
-
{
-
"product_id":
null,
-
"name":
"string",
-
"description":
"string",
-
"price":
20000000,
-
"quantity":
0,
-
"tax":
20000000
}
],
-
"send_invoice":
false,
-
"email_info":
{
-
"body":
"Dear
{customer_name},\n\nPlease
see the Invoice
{invoice_number}
attached.",
-
"subject":
"Invoice {invoice_number}
from
{merchant_company}",
-
"to":
[
-
"string"
],
-
"sms_number":
[
-
"string"
],
-
"attach_invoice":
true
}
}
{
-
"messages":
[
-
"string"
],
-
"invoice_id":
0
}
Returns the requested invoice.
|
id
required
|
integer
>= 1
The invoice ID. |
{
-
"id":
0,
-
"status":
"canceled",
-
"to_email":
"string",
-
"sub_total_amount":
0,
-
"total_amount":
0,
-
"due_amount":
0,
-
"paid_amount":
0,
-
"tax":
0,
-
"created_at":
"2019-08-24T14:15:22Z",
-
"products":
[
-
{
-
"id":
0,
-
"product_id":
null,
-
"name":
"string",
-
"description":
"string",
-
"price":
20000000,
-
"quantity":
0,
-
"tax":
20000000,
-
"surcharge":
0,
-
"subtotal":
0
}
],
-
"payment_link":
"string",
-
"customer_id":
null,
-
"number":
null,
-
"customer_company":
"string",
-
"customer_email":
"string",
-
"billing_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"shipping_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"date":
"2019-08-24",
-
"due_date":
"2019-08-24",
-
"note":
"string",
-
"discount":
{
-
"value":
0,
-
"type":
"percent"
},
-
"requirement":
{
-
"value":
100,
-
"type":
"percent"
},
-
"surcharge":
{
-
"card":
{
-
"value":
0,
-
"type":
"percent"
},
-
"ach":
{
-
"value":
0,
-
"type":
"percent"
}
},
-
"terms":
"string",
-
"action":
"charge"
}
|
id
required
|
integer
>= 1
The invoice ID. |
|
integer or null
Default:
null
The customer ID to send the invoice to. Can be NULL if customer is not saved. |
|
|
string or null
Default:
null
The invoice number. Can be alphanumeric. If set to NULL, will increment the highest numeric invoice number. |
|
| customer_company |
string
<= 255 characters
The customer name. If invoice is linked to a customer and this field is omitted, it will be populated from the customer. |
| customer_email |
string
<emails>
<= 255 characters
The customer email. If invoice is linked to a customer and this field is omitted, it will be populated from the customer. |
|
object
The customer billing info. If invoice is linked to a customer and this field is omitted, it will be populated from the customer. |
|
|
object
The customer shipping info. If invoice is linked to a customer and this field is omitted, it will be populated from the customer. |
|
| date |
string
<date>
The invoice date. Defaults to today's date. |
| due_date |
string
<date>
The date the invoice is due. Defaults to 30 days from invoice date. |
| note |
string
A note to attach to the invoice. |
|
object
Optional discount to apply to the invoice pre tax total. |
|
|
object
Total amount that is required with first payment. Defaults to full due amount. |
|
|
object
An optional surcharge to be applied to card or ACH payments. This field will be overwritten if the ISO/MSP sets a mandatory surcharge. |
|
| terms |
string
Additional terms to attach to the invoice. |
| action |
string
Default:
"charge"
Enum:
"charge"
"authorize"
The action to process the invoice. |
{
-
"customer_id":
null,
-
"number":
null,
-
"customer_company":
"string",
-
"customer_email":
"string",
-
"billing_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"shipping_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"date":
"2019-08-24",
-
"due_date":
"2019-08-24",
-
"note":
"string",
-
"discount":
{
-
"value":
0,
-
"type":
"percent"
},
-
"requirement":
{
-
"value":
100,
-
"type":
"percent"
},
-
"surcharge":
{
-
"card":
{
-
"value":
0,
-
"type":
"percent"
},
-
"ach":
{
-
"value":
0,
-
"type":
"percent"
}
},
-
"terms":
"string",
-
"action":
"charge"
}
{
-
"id":
0,
-
"status":
"canceled",
-
"to_email":
"string",
-
"sub_total_amount":
0,
-
"total_amount":
0,
-
"due_amount":
0,
-
"paid_amount":
0,
-
"tax":
0,
-
"created_at":
"2019-08-24T14:15:22Z",
-
"products":
[
-
{
-
"id":
0,
-
"product_id":
null,
-
"name":
"string",
-
"description":
"string",
-
"price":
20000000,
-
"quantity":
0,
-
"tax":
20000000,
-
"surcharge":
0,
-
"subtotal":
0
}
],
-
"payment_link":
"string",
-
"customer_id":
null,
-
"number":
null,
-
"customer_company":
"string",
-
"customer_email":
"string",
-
"billing_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"shipping_info":
{
-
"first_name":
"string",
-
"last_name":
"string",
-
"street":
"string",
-
"street2":
"string",
-
"state":
"string",
-
"city":
"string",
-
"zip":
"string",
-
"country":
"string",
-
"phone":
"string"
},
-
"date":
"2019-08-24",
-
"due_date":
"2019-08-24",
-
"note":
"string",
-
"discount":
{
-
"value":
0,
-
"type":
"percent"
},
-
"requirement":
{
-
"value":
100,
-
"type":
"percent"
},
-
"surcharge":
{
-
"card":
{
-
"value":
0,
-
"type":
"percent"
},
-
"ach":
{
-
"value":
0,
-
"type":
"percent"
}
},
-
"terms":
"string",
-
"action":
"charge"
}
An invoice can only be sent before a payment is made. Once a payment is made, you must use the Request final payment endpoint.
|
id
required
|
integer
>= 1
The invoice ID. |
| body |
string
Default:
"Dear {customer_name},\n\nPlease see the
Invoice {invoice_number} attached."
An email body.
The default value will fill in the
templated fields. If you supply a body
text, it will be sent exactly as supplied
without any parsing. However, you can add
special escape characters such as
|
| subject |
string
Default:
"Invoice {invoice_number} from
{merchant_company}"
The email subject. The default value will fill in the templated fields. If you supply a subject text, it will be sent exactly as supplied without any parsing. |
| to |
Array of strings
<emails>
A list of email addresses to send to. If
not supplied, it will be populated from
the |
| sms_number |
Array of strings
A list of numbers to send an sms to. |
| attach_invoice |
boolean
Default:
true
Specify if system invoice should be attached to the email. |
{
-
"body":
"Dear
{customer_name},\n\nPlease see
the Invoice {invoice_number}
attached.",
-
"subject":
"Invoice {invoice_number} from
{merchant_company}",
-
"to":
[
-
"string"
],
-
"sms_number":
[
-
"string"
],
-
"attach_invoice":
true
}
|
id
required
|
integer
>= 1
The invoice ID. |
| body |
string
Default:
"Dear {customer_name},\n\nPlease see the
Invoice {invoice_number} attached."
An email body.
The default value will fill in the
templated fields. If you supply a body
text, it will be sent exactly as supplied
without any parsing. However, you can add
special escape characters such as
|
| subject |
string
Default:
"Reactivated Invoice {invoice_number} from
{merchant_company}"
The email subject. The default value will fill in the templated fields. If you supply a subject text, it will be sent exactly as supplied without any parsing. |
| to |
Array of strings
<emails>
A list of email addresses to send to. If
not supplied, it will be populated from
the |
| sms_number |
Array of strings
A list of numbers to send an sms to. |
| attach_invoice |
boolean
Default:
true
Specify if system invoice should be attached to the email. |
{
-
"body":
"Dear
{customer_name},\n\nPlease see
the Invoice {invoice_number}
attached.",
-
"subject":
"Reactivated Invoice
{invoice_number} from
{merchant_company}",
-
"to":
[
-
"string"
],
-
"sms_number":
[
-
"string"
],
-
"attach_invoice":
true
}
Final payment can only be requested for an active invoice that is partially paid.
|
id
required
|
integer
>= 1
The invoice ID. |
| body |
string
Default:
"Dear {customer_name},\n\nPlease see the
Invoice {invoice_number} attached."
An email body.
The default value will fill in the
templated fields. If you supply a body
text, it will be sent exactly as supplied
without any parsing. However, you can add
special escape characters such as
|
| subject |
string
Default:
"Invoice {invoice_number} from
{merchant_company}"
The email subject. The default value will fill in the templated fields. If you supply a subject text, it will be sent exactly as supplied without any parsing. |
| to |
Array of strings
<emails>
A list of email addresses to send to. If
not supplied, it will be populated from
the |
| sms_number |
Array of strings
A list of numbers to send an sms to. |
| attach_invoice |
boolean
Default:
true
Specify if system invoice should be attached to the email. |
{
-
"body":
"Dear
{customer_name},\n\nPlease see
the Invoice {invoice_number}
attached.",
-
"subject":
"Invoice {invoice_number} from
{merchant_company}",
-
"to":
[
-
"string"
],
-
"sms_number":
[
-
"string"
],
-
"attach_invoice":
true
}
Use this endpoint to get an Apple Pay session before processing an Apple Pay transaction.
This endpoint requires a public API key (begins with
pk_).
The url parameter will be supplied by
the Apple Pay JS library when the
onvalidatemerchant handler is invoked.
|
url
required
|
string
The URL retrieved from the
|
{
-
"url":
"string"
}
{ }
|
webhook_url
required
|
string
<= 255 characters
^https://
The url of the webhook. |
| description |
string
[ 1 .. 255 ] characters
The webhook description. |
| active |
boolean
Default:
true
The status of the webhook |
{
-
"webhook_url":
"string",
-
"description":
"string",
-
"active":
true
}
{
-
"id":
0,
-
"signature":
"string",
-
"webhook_url":
"string",
-
"description":
"string",
-
"active":
true
}
Returns a single webhook by webhook ID.
|
id
required
|
integer
>= 1
The webhook ID. |
{
-
"id":
0,
-
"signature":
"string",
-
"webhook_url":
"string",
-
"description":
"string",
-
"active":
true
}
Updates a single webhook by ID.
|
id
required
|
integer
>= 1
The webhook ID. |
| webhook_url |
string
<= 255 characters
^https://
The url of the webhook. |
| description |
string
[ 1 .. 255 ] characters
The webhook description. |
| active |
boolean
Default:
true
The status of the webhook |
{
-
"webhook_url":
"string",
-
"description":
"string",
-
"active":
true
}
{
-
"id":
0,
-
"signature":
"string",
-
"webhook_url":
"string",
-
"description":
"string",
-
"active":
true
}